Eclipse Platform
Pre-release 3.0

Package org.eclipse.team.ui.synchronize

Application programming interfaces for interaction with the Eclipse Synchronize View.

See:
          Description

Interface Summary
ISynchronizeManager Manages synchronization view participants.
ISynchronizeParticipant A synchronize participant provides a logical connection between local resources and a remote location that is used to share those resources.
ISynchronizeParticipantDescriptor A participant descriptor contains the content of the synchronizeParticipants extension section for for a registered participant type in the declaring plug-in's manifest (plugin.xml) file.
ISynchronizeParticipantListener A synchronize participant listener is notified when participants are added or removed from the synchronize manager.
ISynchronizeView A view that displays synchronization participants that are registered with the synchronize manager.
ITeamSubscriberParticipantNode ITeamSubscriberParticipantNode is used in the page created by the TeamSubscriberParticipant to display the kind of change detected in a two or three-way synchronize operation.
 

Class Summary
AbstractSynchronizeParticipant AbstractSynchronizeParticipant is the abstract base class for all synchronize view participants.
TeamSubscriberParticipant A synchronize participant that displays synchronization information for local resources that are managed via a TeamSubscriber.
TeamSubscriberParticipantLabelProvider Provides basic labels for the subscriber participant synchronize view page.
TeamSubscriberParticipantPage A synchronize view page that works with participants that are subclasses of TeamSubscriberParticipant.
 

Package org.eclipse.team.ui.synchronize Description

Application programming interfaces for interaction with the Eclipse Synchronize View.

Package Specification

The Eclipse Team UI plug-in provides a set of classes and interfaces to support a generic synchronize view that can show multiple synchronize participants. This package contains a generic abstract synchronize participant that provides the common functionality for synchronize participants. The basic model for the Synchronize View APIs is the following:

Synchronize participants are declared by extending the synchronizeParticipants extension point. There are two classes of synchronize participants: static participants will be created when the synchronize view is created, and dynamic participants that are created by user code at some other time. A synchronize manager (ISynchronizeManager) manages all active synchronize participants, and provides notification of participants which are added and removed. Participants are displayed in a page book view. Each participant implementation is reponsible for creating its page (IPageBookView), which provides freedom of presentation to the synchronize view implementation. A single participant may be displayed simultaneously in multiple synchronize views, and in different workbench windows.

The class TeamSubscriberParticipant provides an implementation of a synchronize participant that enables synchronization for a TeamSubscriber. For providers that implement a TeamSubscriber, this is the easiest method of integrating into the Synchronize View. The TeamSubscriberParticipant provides a view of changes (incoming, outgoing, conflicting), modes for showing only a subset of the changes, decorations for identifying the changes, and working sets. Here are the steps for creating a participant based on the TeamSubscriberParticipant implementation:


Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.